home *** CD-ROM | disk | FTP | other *** search
/ ETO Development Tools 4 / ETO Development Tools 4.iso / Tools - Objects / MacApp / MacApp 3.0a2 / CPlusIncludes / HyperXCmd.h < prev    next >
Text File  |  1991-05-01  |  11KB  |  251 lines
  1. /*
  2.     HyperXCmd.h
  3.     Definition file for HyperCard XCMDs and XFCNs in C.
  4.     Copyright Apple Computer, Inc.  1987-1990
  5.     All rights reserved
  6.  
  7. */
  8.  
  9.  
  10. #ifndef    __HYPERXCMD__
  11. #define    __HYPERXCMD__
  12.  
  13.  
  14. /* Unlike the old days, we have to make sure we have some definitions first… */
  15.  
  16. #ifndef  __TYPES__
  17. #include <Types.h>
  18. #endif
  19.  
  20. #ifndef __GEOMETRY__
  21. #include <Geometry.h>
  22. #endif
  23.  
  24. #ifndef __EVENTS__
  25. #include <Events.h>
  26. #endif
  27.  
  28. #ifndef __TEXTEDIT__
  29. #include <TextEdit.h>
  30. #endif
  31.  
  32. #ifndef __MENUS__
  33. #include <Menus.h>
  34. #endif
  35.  
  36. #ifndef __STANDARDFILE__
  37. #include <StandardFile.h>
  38. #endif
  39.  
  40.  
  41.  
  42. /* result codes */
  43. #define xresSucc                0
  44. #define xresFail                1
  45. #define xresNotImp                2
  46.  
  47. /* XCMDBlock constants for event.what... */
  48. #define xOpenEvt                1000    /* the first event after you are created */
  49. #define xCloseEvt                1001    /* your window is being forced close (Quit?) */
  50. #define xGiveUpEditEvt            1002    /* you are losing Edit... */
  51. #define xGiveUpSoundEvt            1003    /* you are losing the sound channel... */
  52. #define xHidePalettesEvt        1004    /* someone called HideHCPalettes */
  53. #define xShowPalettesEvt        1005    /* someone called ShowHCPalettes */
  54. #define xEditUndo                1100    /* Edit——Undo */
  55. #define xEditCut                1102    /* Edit——Cut */
  56. #define xEditCopy                1103    /* Edit——Copy */
  57. #define xEditPaste                1104    /* Edit——Paste */
  58. #define xEditClear                1105    /* Edit——Clear */
  59. #define xSendEvt                1200    /* script has sent you a message (text) */
  60. #define xSetPropEvt                1201    /* set a window property */
  61. #define xGetPropEvt                1202    /* get a window property */
  62. #define xCursorWithin            1300    /* cursor is within the window */
  63. #define xMenuEvt                1400    /* user has selected an item in your menu */
  64. #define xMBarClickedEvt            1401    /* a menu is about to be shown--update if needed */
  65.  
  66. #define xShowWatchInfoEvt        1501    /* for variable and message watchers */
  67. #define xScriptErrorEvt            1502    /* place the insertion point */
  68. #define xDebugErrorEvt            1503    /* user clicked "Debug" at a complaint */
  69. #define xDebugStepEvt            1504    /* hilite the line */
  70. #define xDebugTraceEvt            1505    /* same as step but tracing */
  71. #define xDebugFinishedEvt        1506    /* script ended */
  72.  
  73. #define paletteProc                2048    /* Windoid with grow box */
  74. #define palNoGrowProc            2052    /* standard Windoid defproc */
  75. #define palZoomProc                2056    /* Windoid with zoom and grow */
  76. #define palZoomNoGrow            2060    /* Windoid with zoom and no grow */
  77. #define hasZoom                    8
  78. #define hasTallTBar                2
  79. #define toggleHilite            1
  80.  
  81.  
  82. #define maxCachedChecks            16        /* maximum number of checkpoints in a script */
  83.  
  84.  
  85. /* paramCount is set to these constants when first calling special XThings */
  86. #define xMessageWatcherID        = -2;
  87. #define xVariableWatcherID        = -3;
  88. #define xScriptEditorID            = -4;
  89. #define xDebuggerID                = -5;
  90.  
  91. /* XTalkObjectPtr->objectKind values */
  92. #define stackObj                1
  93. #define bkgndObj                2
  94. #define cardObj                    3
  95. #define fieldObj                4
  96. #define buttonObj                5
  97.  
  98.  
  99. typedef struct XCmdBlock *XCmdPtr; 
  100. struct XCmdBlock {
  101.     short paramCount;         /* If = -1 then new use for XWindoids */
  102.     Handle params[16];
  103.     Handle returnValue;
  104.     Boolean passFlag;
  105.  
  106.     Ptr entryPoint;             /* to call back to HyperCard */
  107.     short request;
  108.     short result;
  109.     long inArgs[8];
  110.     long outArgs[4];
  111. };
  112.  
  113. typedef struct XWEventInfo *XWEventInfoPtr; 
  114. struct XWEventInfo {
  115.     EventRecord event;
  116.     WindowPtr eventWindow;
  117.     long eventParams[9];
  118.     Handle eventResult;
  119. };
  120.  
  121. typedef struct XTalkObject *XTalkObjectPtr;
  122. struct XTalkObject {
  123.     short objectKind;        /* stack, bkgnd, card, field, or button */
  124.     long stackNum;            /* reference number of the source stack */
  125.     long bkgndID;
  126.     long cardID;
  127.     long buttonID;
  128.     long fieldID;
  129. };
  130.  
  131.  
  132. typedef struct CheckPts *CheckPtPtr;
  133. typedef CheckPtPtr *CheckPtHandle; 
  134. struct CheckPts {
  135.     short checks[maxCachedChecks];
  136. };
  137.  
  138.  
  139. /****  HyperTalk Utilities  ****/
  140. extern pascal Handle EvalExpr(XCmdPtr paramPtr, StringPtr expr);
  141. extern pascal void SendCardMessage(XCmdPtr paramPtr, StringPtr msg);
  142. extern pascal void SendHCMessage(XCmdPtr paramPtr, StringPtr msg);
  143. extern pascal void RunHandler(XCmdPtr paramPtr, Handle handler);
  144.  
  145. /****  Memory Utilities  ****/
  146. extern pascal Handle GetGlobal(XCmdPtr paramPtr, StringPtr globName);
  147. extern pascal void SetGlobal(XCmdPtr paramPtr, StringPtr globName, Handle globValue);
  148. extern pascal void ZeroBytes(XCmdPtr paramPtr, Ptr dstPtr, long longCount);
  149.  
  150. /****  String Utilities  ****/
  151. extern pascal void ScanToReturn(XCmdPtr paramPtr, Ptr& scanPtr);
  152. extern pascal void ScanToZero(XCmdPtr paramPtr, Ptr& scanPtr);
  153. extern pascal Boolean StringEqual(XCmdPtr paramPtr, StringPtr str1, StringPtr str2);
  154. extern pascal long StringLength(XCmdPtr paramPtr, Ptr strPtr);
  155. extern pascal Ptr StringMatch(XCmdPtr paramPtr, StringPtr pattern, Ptr target);
  156. extern pascal void ZeroTermHandle(XCmdPtr paramPtr, Handle hndl);                                
  157.  
  158. /****  String Conversions  ****/
  159. extern pascal void BoolToStr(XCmdPtr paramPtr, Boolean bool, StringPtr str);
  160. extern pascal void ExtToStr(XCmdPtr paramPtr, extended num, StringPtr str);
  161. extern pascal void LongToStr(XCmdPtr paramPtr, long posNum, StringPtr str);
  162. extern pascal void NumToHex(XCmdPtr paramPtr, long num, short nDigits, StringPtr str);
  163. extern pascal void NumToStr(XCmdPtr paramPtr, long num, StringPtr str);
  164. extern pascal Handle PasToZero(XCmdPtr paramPtr, StringPtr str);
  165. extern pascal void PointToStr(XCmdPtr paramPtr, Point pt, StringPtr str);                        
  166. extern pascal void RectToStr(XCmdPtr paramPtr, Rect& rct, StringPtr str);                        
  167. extern pascal void ReturnToPas(XCmdPtr paramPtr, Ptr zeroStr, StringPtr pasStr);
  168. extern pascal Boolean StrToBool(XCmdPtr paramPtr, StringPtr str);
  169. extern pascal extended StrToExt(XCmdPtr paramPtr, StringPtr str);
  170. extern pascal long StrToLong(XCmdPtr paramPtr, StringPtr str);
  171. extern pascal long StrToNum(XCmdPtr paramPtr, StringPtr str);
  172. extern pascal void StrToPoint(XCmdPtr paramPtr, StringPtr str, Point& pt);                        
  173. extern pascal void StrToRect(XCmdPtr paramPtr, StringPtr str, Rect& rct);                        
  174. extern pascal void ZeroToPas(XCmdPtr paramPtr, Ptr zeroStr, StringPtr pasStr);
  175.  
  176. /****  Field Utilities  ****/
  177. extern pascal Handle GetFieldByID(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID);
  178. extern pascal Handle GetFieldByName(XCmdPtr paramPtr, Boolean cardFieldFlag, StringPtr fieldName);
  179. extern pascal Handle GetFieldByNum(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldNum);
  180. extern pascal void SetFieldByID(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID,
  181.     Handle fieldVal);
  182. extern pascal void SetFieldByName(XCmdPtr paramPtr, Boolean cardFieldFlag,
  183.     StringPtr fieldName, Handle fieldVal);
  184. extern pascal void SetFieldByNum(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldNum,
  185.     Handle fieldVal);
  186. extern pascal TEHandle GetFieldTE(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID,
  187.     short fieldNum, StringPtr fieldNamePtr);                                                    
  188. extern pascal void SetFieldTE(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID,
  189.     short fieldNum, StringPtr fieldNamePtr, TEHandle fieldTE);                                    
  190.  
  191. /****  Miscellaneous Utilities  ****/  /* ALL NEW */
  192. extern pascal void BeginXSound(XCmdPtr paramPtr);
  193. extern pascal void EndXSound(XCmdPtr paramPtr);
  194. extern pascal Boolean GetFilePath(XCmdPtr paramPtr, StringPtr fileName, short numTypes, SFTypeList typeList,
  195.     Boolean askUser, OSType& fileType, StringPtr fullName);
  196. extern pascal void GetXResInfo(XCmdPtr paramPtr, short& resFile, short& resID);
  197. extern pascal void Notify(XCmdPtr paramPtr);
  198. extern pascal void SendHCEvent(XCmdPtr paramPtr, EventRecord& event);
  199. extern pascal void SendWindowMessage(XCmdPtr paramPtr, WindowPtr windPtr, 
  200.     StringPtr windowName, Handle msg);
  201. extern pascal WindowPtr FrontDocWindow(XCmdPtr paramPtr);
  202. extern pascal long StackNameToNum(XCmdPtr paramPtr, StringPtr stackName);
  203. extern pascal short ShowHCAlert(XCmdPtr paramPtr, short dlgID, StringPtr promptStr);
  204.  
  205. /****  Creating and Disposing XWindoids  ****/  /* ALL NEW */
  206. extern pascal WindowPtr NewXWindow(XCmdPtr paramPtr, Rect& boundsRect, StringPtr title, 
  207.    Boolean visible, short procID, Boolean color, Boolean floating);
  208. extern pascal WindowPtr GetNewXWindow(XCmdPtr paramPtr, ResType templateType, short 
  209.    templateID, Boolean color, Boolean floating);
  210. extern pascal void CloseXWindow(XCmdPtr paramPtr, WindowPtr window);
  211.  
  212. /****  XWindoid Utilities  ****/  /* ALL NEW */
  213. extern pascal void HideHCPalettes(XCmdPtr paramPtr);
  214. extern pascal void ShowHCPalettes(XCmdPtr paramPtr);
  215. extern pascal void RegisterXWMenu(XCmdPtr paramPtr, WindowPtr window, MenuHandle& menu, Boolean registering);
  216. extern pascal void SetXWIdleTime(XCmdPtr paramPtr, WindowPtr window, long interval);
  217. extern pascal void XWHasInterruptCode(XCmdPtr paramPtr, WindowPtr window, Boolean haveCode);
  218. extern pascal void XWAlwaysMoveHigh(XCmdPtr paramPtr, WindowPtr window, Boolean moveHigh);
  219. extern pascal void XWAllowReEntrancy(XCmdPtr paramPtr, WindowPtr window, Boolean allowSysEvts, Boolean allowHCEvts);
  220.  
  221. /****  Text Editing Utilities  ****/  /* ALL NEW */
  222. extern pascal void BeginXWEdit(XCmdPtr paramPtr, WindowPtr window);
  223. extern pascal void EndXWEdit(XCmdPtr paramPtr, WindowPtr window);
  224. extern pascal Ptr HCWordBreakProc(XCmdPtr paramPtr);
  225. extern pascal void PrintTEHandle(XCmdPtr paramPtr, TEHandle hTE, StringPtr header);
  226.  
  227. /****  Script Editor support  ****/  /* ALL NEW */
  228. extern pascal CheckPtHandle GetCheckPoints(XCmdPtr paramPtr);
  229. extern pascal void SetCheckPoints(XCmdPtr paramPtr, CheckPtHandle checkLines);
  230. extern pascal void FormatScript(XCmdPtr paramPtr, Handle scriptHndl, long& insertionPoint, Boolean quickFormat);
  231. extern pascal void SaveXWScript(XCmdPtr paramPtr, Handle scriptHndl);
  232. extern pascal void GetObjectName(XCmdPtr paramPtr, XTalkObjectPtr object, StringPtr objName);
  233. extern pascal void GetObjectScript(XCmdPtr paramPtr, XTalkObjectPtr object, Handle& scriptHndl);
  234. extern pascal void SetObjectScript(XCmdPtr paramPtr, XTalkObjectPtr object, Handle scriptHndl);
  235.  
  236. /****  Debugging Tools support  ****/  /* ALL NEW */
  237. extern pascal void AbortScript(XCmdPtr paramPtr);
  238. extern pascal void GoScript(XCmdPtr paramPtr);
  239. extern pascal void StepScript(XCmdPtr paramPtr, Boolean stepInto);
  240. extern pascal void CountHandlers(XCmdPtr paramPtr, short& handlerCount);
  241. extern pascal void GetHandlerInfo(XCmdPtr paramPtr, short handlerNum, StringPtr handlerName, 
  242.                                   StringPtr objectName, short& varCount);
  243. extern pascal void GetVarInfo(XCmdPtr paramPtr, short handlerNum, short varNum, StringPtr varName, 
  244.                               Boolean& isGlobal, StringPtr varValue, Handle varHndl);
  245. extern pascal void SetVarValue(XCmdPtr paramPtr, short handlerNum, short varNum, Handle varHndl);
  246. extern pascal Handle GetStackCrawl(XCmdPtr paramPtr);
  247. extern pascal void TraceScript(XCmdPtr paramPtr, Boolean traceInto);
  248.  
  249.  
  250. #endif
  251.